Connected System

Overview

Connected system objects hold the details needed for authentication and establishing connections. They make it simple to link with external integrations and data sources, and they also support deploying across multiple environments by allowing different connection settings for each one.

Create

To create a connected system:

1. In your application go to application view, select an application and either click on the application name or go to object view.
2. Click the Create New drop down and select Connected System.
3. Configure the following properties:

• Name

4. Click create.

After creating, it opens in a new dialog or window where you can configure the following properties:

Fields in Connected System

1. System Name

   • Unique name to identify the connected system.
   • Example: AIT_Open_Ai_Cs.

2. Description

   • Optional field to describe the purpose of the system integration.

3. Base URL

   • The root endpoint of the API that will be used by all integrations.
   • Example:

     https://api.openai.com/v1/

4. Authentication Type

   • Defines how the external system is authenticated.
   • Example: API Key Authorization.

5. Token for the API

   • The actual API Key or token required to authenticate requests with the external system.
   • This value is kept secure and masked.

Property	Description
System name	This is the internal name for the connected system object. It's used to identify and reference the system within the platform (e.g., when configuring integrations).
Description	An optional text field to briefly explain what this connected system is for — such as what service it connects to, its purpose, or usage notes.
Base URL	The root endpoint for the external system or API you want to integrate with. All relative paths defined in the integration will be appended to this URL to form the final endpoint.
Authentication Type	This specifies the authentication method used to securely connect to the external system. The drop down will let you choose the appropriate method based on what the external service requires.
Token for the API	Secure API token or key required to authorize requests to the external system. This should be kept confidential and never shared.

Connected System Requirement for Integration :

A Connected System is required for creating an Integration - we must first create a Connected System (with Base URL and authentication details) before it can be used inside an Integration.